/*-------------------------------------------------------------------------
 *
 * base64.c
 *	  用于无空格的base64的编码和解码例程。
 *
 * Copyright (c) 2001-2022, PostgreSQL Global Development Group
 *
 *
 * IDENTIFICATION
 *	  src/common/base64.c
 *
 *-------------------------------------------------------------------------
 */

#ifndef FRONTEND
#include "postgres.h"
#else
#include "postgres_fe.h"
#endif

#include "common/base64.h"

/*
 * BASE64
 */

static const char _base64[] =
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";

static const int8 b64lookup[128] = {
	-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
	-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
	-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, -1, -1, 63,
	52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, -1, -1, -1, -1,
	-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
	15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1, -1, -1, -1, -1,
	-1, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
	41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, -1, -1, -1, -1, -1,
};

/*
 * pg_b64_encode
 *
 * 将给定的字符串编码为base64。 返回编码字符串的长度，
 * 如果发生错误则返回-1，结果缓冲区出于安全原因被清零。
 */
int pg_b64_encode(const char *fc_src, int fc_len, char *fc_dst, int fc_dstlen)
{
	char	   *fc_p;
	const char *fc_s,
			   *fc_end = fc_src + fc_len;
	int			fc_pos = 2;
	uint32		fc_buf = 0;

	fc_s = fc_src;
	fc_p = fc_dst;

	while (fc_s < fc_end)
	{
		fc_buf |= (unsigned char) *fc_s << (fc_pos << 3);
		fc_pos--;
		fc_s++;

		/* 写出它 */
		if (fc_pos < 0)
		{
			/*
			 * 如果编码字符串分配区域发生溢出，则离开。
			 */
			if ((fc_p - fc_dst + 4) > fc_dstlen)
				goto error;

			*fc_p++ = _base64[(fc_buf >> 18) & 0x3f];
			*fc_p++ = _base64[(fc_buf >> 12) & 0x3f];
			*fc_p++ = _base64[(fc_buf >> 6) & 0x3f];
			*fc_p++ = _base64[fc_buf & 0x3f];

			fc_pos = 2;
			fc_buf = 0;
		}
	}
	if (fc_pos != 2)
	{
		/*
		 * 如果编码字符串分配区域发生溢出，则离开。
		 */
		if ((fc_p - fc_dst + 4) > fc_dstlen)
			goto error;

		*fc_p++ = _base64[(fc_buf >> 18) & 0x3f];
		*fc_p++ = _base64[(fc_buf >> 12) & 0x3f];
		*fc_p++ = (fc_pos == 0) ? _base64[(fc_buf >> 6) & 0x3f] : '=';
		*fc_p++ = '=';
	}

	Assert((fc_p - fc_dst) <= fc_dstlen);
	return fc_p - fc_dst;

error:
	memset(fc_dst, 0, fc_dstlen);
	return -1;
}

/*
 * pg_b64_decode
 *
 * 解码给定的base64字符串。 在成功的情况下返回解码字符串的长度，
 * 如果发生错误则返回-1，结果缓冲区出于安全原因被清零。
 */
int pg_b64_decode(const char *fc_src, int fc_len, char *fc_dst, int fc_dstlen)
{
	const char *fc_srcend = fc_src + fc_len,
			   *fc_s = fc_src;
	char	   *fc_p = fc_dst;
	char		fc_c;
	int			fc_b = 0;
	uint32		fc_buf = 0;
	int			fc_pos = 0,
				fc_end = 0;

	while (fc_s < fc_srcend)
	{
		fc_c = *fc_s++;

		/* 如果发现空白字符则离开 */
		if (fc_c == ' ' || fc_c == '\t' || fc_c == '\n' || fc_c == '\r')
			goto error;

		if (fc_c == '=')
		{
			/* 结束序列 */
			if (!fc_end)
			{
				if (fc_pos == 2)
					fc_end = 1;
				else if (fc_pos == 3)
					fc_end = 2;
				else
				{
					/*
					 * 解码base64序列时发现意外的“=”字符。
					 */
					goto error;
				}
			}
			fc_b = 0;
		}
		else
		{
			fc_b = -1;
			if (fc_c > 0 && fc_c < 127)
				fc_b = b64lookup[(unsigned char) fc_c];
			if (fc_b < 0)
			{
				/* 发现无效符号 */
				goto error;
			}
		}
		/* 将其添加到缓冲区 */
		fc_buf = (fc_buf << 6) + fc_b;
		fc_pos++;
		if (fc_pos == 4)
		{
			/*
			 * 如果解码字符串分配区域发生溢出，则离开。
			 */
			if ((fc_p - fc_dst + 1) > fc_dstlen)
				goto error;
			*fc_p++ = (fc_buf >> 16) & 255;

			if (fc_end == 0 || fc_end > 1)
			{
				/* 溢出检查 */
				if ((fc_p - fc_dst + 1) > fc_dstlen)
					goto error;
				*fc_p++ = (fc_buf >> 8) & 255;
			}
			if (fc_end == 0 || fc_end > 2)
			{
				/* 溢出检查 */
				if ((fc_p - fc_dst + 1) > fc_dstlen)
					goto error;
				*fc_p++ = fc_buf & 255;
			}
			fc_buf = 0;
			fc_pos = 0;
		}
	}

	if (fc_pos != 0)
	{
		/*
		 * base64结束序列无效。 输入数据缺少填充，或者被截断或其他方式损坏。
		 */
		goto error;
	}

	Assert((fc_p - fc_dst) <= fc_dstlen);
	return fc_p - fc_dst;

error:
	memset(fc_dst, 0, fc_dstlen);
	return -1;
}

/*
 * pg_b64_enc_len
 *
 * 根据调用者提供的长度返回如果将字符串编码为base64的长度。
 * 这有助于估算在进行实际编码之前需要分配多大的缓冲区。
 */
int pg_b64_enc_len(int fc_srclen)
{
	/* 3个字节将被转换为4个字节 */
	return (fc_srclen + 2) * 4 / 3;
}

/*
 * pg_b64_dec_len
 *
 * 根据调用者提供的长度返回如果将字符串解码为base64的长度。
 * 这有助于估算在进行实际解码之前需要分配多大的缓冲区。
 */
int pg_b64_dec_len(int fc_srclen)
{
	return (fc_srclen * 3) >> 2;
}
